************
INTRODUCTION
************

This file describes how to generate the Java wrapper for the Melissa Data Address Object.


*************
PREREQUISITES
*************

To make use of the Address Object java wrapper you will need:

* An installation of a Java Developer's Kit 1.4.2 or later or an equivalent product.

* The Melissa DATA Address Object library and data files installed.

	Library = libmdAddr.so
	Data Files = mdAddr.dat, mdAddr.nat, mdAddr.str, mdAddr.lic

  These files are installed automatically if you run setup.sh. 

You will need to know the location of these items in order to install and run the java wrapper.


*************
Installation
*************

Copy the entire folder that contains this README.txt into a local directory on your computer.


*****
Setup
*****

Open BuildWrapper.sh in a text editor. Put the path of the installed Address Object library files into mdAddrPath.

	declare -r mdAddrPath="The Path To Your AddrObj Directory"

Also, make sure  your JAVA_HOME enviornment variable is set:

	ex: export JAVA_HOME=/usr/lib/jvm/jdk1.6

*******************
Running the Script
*******************

Execute BuildWrapper.sh (sh BuildWrapper.sh). This should create a file named libmdAddrJavaWrapper.so and mdAddr.jar.

After the files are successfully generated, they are ready for use. Place them in the folder containing your application/project.

***********
Sample Code
***********

The 'Samples' folder (found two folder levels up) copntains some sample programs that show off the basic functionality of the Address object and also can be used as reference on how to interface with the object.

*******
Updates
*******

libmdAddrJavaWrapper.so and mdAddr.jar build by BuildWrapper.sh do not need to be re-built for every single update. For normal updates, simply replacing libmdAddr.so and the data files are enough. However, if there is a change in libmdAddr.so like a new method, you will need to rebuild the wrapper to use the new method. 

COPYRIGHT NOTICE

(C) 2014 Melissa Data Corporation. All rights reserved.
